gulplog

What is gulplog?

The 'gulplog' npm package is a simple logging utility designed for use with Gulp, a popular task runner for automating development workflows. It provides a straightforward way to log messages at different levels (info, warn, error, and debug) during the execution of Gulp tasks.

What are gulplog's main functionalities?

Info Logging

Logs an informational message. This is useful for general messages that indicate the progress or state of a task.

const gulplog = require('gulplog');
gulplog.info('This is an info message');

Warning Logging

Logs a warning message. This is useful for non-critical issues that do not stop the task but should be noted.

const gulplog = require('gulplog');
gulplog.warn('This is a warning message');

Error Logging

Logs an error message. This is useful for critical issues that may stop the task or require immediate attention.

const gulplog = require('gulplog');
gulplog.error('This is an error message');

Debug Logging

Logs a debug message. This is useful for detailed debugging information that can help diagnose issues during development.

const gulplog = require('gulplog');
gulplog.debug('This is a debug message');

Other packages similar to gulplog

winston

Winston is a versatile logging library for Node.js that supports multiple transports (e.g., console, file, HTTP). It is more feature-rich compared to gulplog, offering advanced logging capabilities such as log levels, custom formats, and more.

bunyan

Bunyan is a simple and fast JSON logging library for Node.js services. It provides structured logging and is designed for high-performance logging in production environments. Compared to gulplog, Bunyan offers more advanced features like log streams and serializers.

pino

Pino is a low-overhead logging library for Node.js that focuses on performance. It is designed to be extremely fast and efficient, making it suitable for high-throughput applications. Pino offers more advanced features and better performance compared to gulplog.

README

gulplog

Logger for gulp and gulp plugins

Usage

var logger = require('gulplog');

// logs strings
logger.debug('The MOST verbose!');
logger.info('Some important info');
logger.warn('All the warnings to you');
logger.error('OH NO! SOMETHING HAPPENED!');

// supports util.format!
logger.info('%s style!', 'printf');

// log anything
logger.debug({ my: 'obj' });
logger.info([1, 2, 3]);

API

Logging (and level of logging) is controlled by gulp-cli

logger.debug(msg)

Highest log level. Typically used for debugging purposes.

If the first argument is a string, all arguments are passed to node's util.format() before being emitted.

logger.info(msg)

Standard log level. Typically used for user information.

If the first argument is a string, all arguments are passed to node's util.format() before being emitted.

logger.warn(msg)

Warning log level. Typically used for warnings.

If the first argument is a string, all arguments are passed to node's util.format() before being emitted.

logger.error(msg)

Error log level. Typically used when things went horribly wrong.

If the first argument is a string, all arguments are passed to node's util.format() before being emitted.

License

MIT